Create Weekly SKP Release Notes

Tech Writers and PM work together to create the weekly release notes for Syniti Knowledge Platform (SKP).

NOTE: The weekly update is for the SKP, Match, Replicate and Orchestrate. Construct and Migrate produce monthly release notes per their cadence.

To create the weekly release notes:

  1. Ensure PM has reviewed the tickets and added the ReleaseNotes label to all tickets being released.

  1. Run the following query: resolutiondate >= -7d and project = "Syniti Knowledge Platform" and "Test Status[Labels]" in (ProdTested) and labels in (ReleaseNotes) order by created DESC. Refer to Run a Query in Jira for more information.

    Or

    Save this filter: https://entota.atlassian.net/issues/?filter=22438

  2. Draft the release notes in a Google doc following these standards and named SKP Release Notes mm/dd/yy by Friday morning.

  3. Post a note in the Slack channel #release-notes asking PMs to review.

  4. Incorporate PM's feedback.

  5. Add the weekly updates to SCReleases.htm file in the Flare project igc-help following these steps. Add a new month if needed. Examples are provided. Push release notes to Dev.

  6. Post a note in the Slack channel #release-notes to ask for peer review from other writers before adding the content to help. Include a link to Dev and to the Google doc.

  7. Update SCReleases.htm with Tech Writer's feedback (if any) and push release notes to Prod.

  8. Post the release notes in the #skp_releases channel. Example provided below.

No Release Notes to Publish

If there aren't any release notes being published, update What's New with the following text:

We are busy enhancing the Syniti Knowledge Platform, but nothing is ready for release just yet. Check back next week!

Run a Query in Jira

To run a query in Jira:

  1. Click in the Search bar.

  2. Click Advanced issue search.

  3. Click Switch to JQL.

  4. Delete any contents that may be in the text box.

  5. Paste the query into the text box.

  6. Click Search.

Post the Release Notes link to Slack channel

This needs to be done before EOB on Friday and posted to #skp_releases.

Example posting:

Weekly release notes for 7/1/2022 for the SKP are published.

https://skthelp.syniti.com/SCReleases.htm

 

Standards

  • Asset names are lower case

  • Page names are italicized

  • Only the release note title and colon are bold - nothing else

  • When applicable, remove the Jira ticket number and engineer's name from the PR titles

  • Mentions of i18nexus with “translations” are not included in the weekly notes.

  • Use the date format [MonthName], ##, ####, e.g., May 8, 2023 for the release date

Examples of prior Release Notes